Skip to content

docs: record proTES configuration - #179

Merged
uniqueg merged 3 commits into
mainfrom
docs/gi31-protes-config
Nov 18, 2026
Merged

uniqueg merged 3 commits into
mainfrom
docs/gi31-protes-config

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

Summary

Records the effective configuration of the ELIXIR On-Cloud's proTES on its operator page (docs/operators/services/protes.md), as decided for generic-issues#31: deployment (chart and image of the v0.6.0 release on Rahti), LS Login as the only issuer, the accepted clients (Krini, Cloud Registry UI), groups from userinfo, the group mapping (ECP_CLN:EOC-Compute -> user, ECP_CLN:ADMIN -> admin plus the three added rules that let admins run tasks), the TES service (CSC test TESK, auth: none) and plugins (none). The page no longer points to generic-issues#31 for this; it points to generic-issues#111 for the switch to proTES' own service token.

Also: the access row now names ECP_CLN:ADMIN next to ECP_CLN:EOC-Compute, and last_verified is set to 2026-11-18, as every fact of the page was checked against its source (live service info, the deployed configuration read with oc get (no Secrets), the proTES v0.6.0 docs).

Light lane: docs-only change to one page, no code, CI or configuration.

Verification

  • GET https://protes.rahtiapp.fi/ga4gh/tes/v1/service-info: version 0.6.0, TES 1.1.0, environment test, one backend https://csc-tesk-noauth.rahtiapp.fi, no capabilities.

  • Deployed config overlay (ConfigMap protes-config) and images (oc get deploy,statefulset) match the table.

  • python scripts/check_names.py: ok.

  • pytest: 356 passed, 100% coverage.

  • DOCS_REGISTRY_OFFLINE=1 mkdocs build --strict: ok. The online build couldn't run locally: https://elixir-on.cloud/ga4gh/registry/v1/services timed out from this machine; CI runs the online build.

  • After merging main and the Sourcery fix (1882e73): CI green (CI passed, Docs, Test, PR title, CodeQL), Read the Docs build succeeded, Sourcery check passed.

Declined review findings

Light lane, self-reviewed. Sourcery threads declined, with replies in each thread:

  • "Tasks cannot reach live Node backends" and "Own client still absent": out of scope by maintainer decision; generic-issues#31 is done once the current configuration is recorded. Node backends and proTES' own client follow in generic-issues#47 and generic-issues#111.
  • "Admins still told to join compute": the researchers' page is for researchers; ECP_CLN:ADMIN isn't requested there.
  • "Other group members cannot submit tasks": deliberate; only EOC-Compute and ADMIN members run tasks. The page now says so (1882e73).
  • "FOCA token validation": test evidence belongs in generic-issues#46, not on the configuration page.

Open questions

None.

Closes elixir-cloud-aai/generic-issues#31

🤖 Generated with Claude Code

Summary by Sourcery

Document the verified production configuration and access model for the ELIXIR On-Cloud proTES service.

Enhancements:

  • Record the effective ELIXIR On-Cloud proTES deployment, authentication, authorization, TES backend, and plugin configuration in the operator documentation.
  • Clarify access for ECP_CLN:ADMIN alongside ECP_CLN:EOC-Compute and document the planned transition to proTES-managed service tokens.

Documentation:

  • Update the proTES operator page with verified configuration details, access-control behavior, and related issue references.

Record the effective configuration of the ELIXIR On-Cloud's proTES on
its operator page: deployment, token issuer and audience, group
mapping and the added admin rules, TES services and plugins. Mark the
page verified against the live service info and configuration, and
name ECP_CLN:ADMIN next to EOC-Compute in the access row.

Refs elixir-cloud-aai/generic-issues#31

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Documentation

Record the verified proTES deployment and access configuration, including its group mapping, TES backend, plugins, and follow-up for service-token support.

  • docs/operators/services/protes.md L2, L40, L50-89

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@uniqueg uniqueg closed this Nov 18, 2026
@uniqueg uniqueg reopened this Nov 18, 2026
@read-the-docs-community

read-the-docs-community Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 elixir-on-cloud-docs | 🛠️ Build #35977133 | 📁 Comparing 1882e73 against latest (1e81aca)

  🔍 Preview build  

2 files changed
± partners-and-developers/ga4gh-standards/index.html
± operators/services/protes/index.html

@uniqueg
uniqueg marked this pull request as ready for review November 18, 2026 05:12
@sourcery-ai

sourcery-ai Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Linked issues

Checked at commit 1882e73

#31 chore: configure proTES for ELIXIR On-Cloud · 0 of 6 met

# Requirement Status Notes
1 Register a proTES client-credentials client at LS Login and store its credentials as a deployment Secret. ❌ Not addressed The page says proTES does not use its own client yet and defers this work.
2 Check real LS Login tokens for the group entitlements, subgroup inheritance, claim source, and FOCA JWKS and userinfo validation. 🟡 Partly met The page records the subgroup entitlement values, userinfo claim, and parent-group behavior, but does not record validation of FOCA's JWKS and userinfo handling with real tokens.
3 Configure the issuer, userinfo group claim, frontend audience, and group mappings for user and admin. 🟡 Partly met The page records the issuer, audience, userinfo claim, and EOC-Compute/ADMIN mappings, but says the parent ECP_CLN value is not mapped.
4 Configure every live production backend with its authentication mode. 🟡 Partly met The page records only the CSC test TESK with auth: none, rather than the authentication modes for every live production backend.
5 Accept task requests from ECP_CLN members and subgroup members, and reject non-members with 403. 🟡 Partly met The page documents access for EOC-Compute and ADMIN and 403 responses for tokens without either group, but says members of other ECP_CLN subgroups get no role.
6 Route tasks to every live Node's backend via its configured authentication mode. 🟡 Partly met The page documents only the CSC test TESK, so it does not establish routing to every live Node backend.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 4 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/operators/services/protes.md" line_range="69" />
<code_context>
+| Role `admin` | `urn:geant:lifescience-ri.eu:group:elixir:ECP_CLN:ADMIN#aai.lifescience-ri.eu`: the permissions API (`/admin/access-control/permissions`, on the public address) and the provenance of all tasks; three added rules (`admins-create-list-tasks`, `admins-list-plugins`, `admins-get-plugins`) give it the rights of `user` too |
+| Other tokens | valid tokens without either group get `403 Forbidden` on tasks and plugins; the service info is public |
+| Own tasks | only the user who created a task can read and cancel it; admins can read the provenance of any task, not the task |
+| TES services | the TESK for tests at CSC, without authentication (`auth: none`) |
+| Plugins | none configured (the service info lists no capabilities) |
+
</code_context>
<issue_to_address>
**Tasks cannot reach live Node backends**

When proTES is expected to serve production tasks through live Node backends, the documented TES configuration lists only the unauthenticated CSC test TESK and says no Node TES service has been added, leaving live production backends without configuration or documented authentication modes; operators see only the sandbox service.

Add each live Node TES backend to the proTES configuration and document its authentication mode.
</issue_to_address>

### Comment 2
<location path="docs/operators/services/protes.md" line_range="77-80" />
<code_context>
+`ECP_CLN:ADMIN` assigned to its facility and its client ID added to the
+audience (see [LS Login](../ls-login.md)).
+
+proTES doesn't use a client of its own yet. Once it calls the TES services
+with its own LS Login token, the TESK at CSC moves to an address that
+requires tokens and its entry here changes from `auth: none` to
+`client_credentials` ([generic-issues#111][gi-111]).
+
+[gi-111]: <https://github.com/elixir-cloud-aai/generic-issues/issues/111>
</code_context>
<issue_to_address>
**Own client still absent**

The issue asks for a proTES client-credentials client and deployment Secret. The page instead says proTES has no client of its own yet and defers that work to generic-issues#111.
</issue_to_address>

### Comment 3
<location path="docs/operators/services/protes.md" line_range="40" />
<code_context>
 | Address | TES API at `https://protes.rahtiapp.fi/ga4gh/tes/v1` (the host itself has no page) |
 | Version | proTES 0.6.0 |
-| Access | LS Login access tokens of members of the group `ECP_CLN:EOC-Compute`, issued to a client that it accepts, such as Krini's (see [Researchers](../../researchers/index.md#before-you-start)) |
+| Access | LS Login access tokens of members of the group `ECP_CLN:EOC-Compute` or `ECP_CLN:ADMIN`, issued to a client that it accepts, such as Krini's (see [Researchers](../../researchers/index.md#before-you-start)) |
 | Environment | `test`: its service info calls it "proTES sandbox (BioHackathon 2026)" |
 | TES services | one, listed in its configuration: the TESK for tests at CSC (`csc-tesk-noauth.rahtiapp.fi`), which accepts tasks without a token |
</code_context>
<issue_to_address>
**Admins still told to join compute**

When a member of `ECP_CLN:ADMIN` without `ECP_CLN:EOC-Compute` follows the researcher start instructions to use proTES, the researchers start page still presents `ECP_CLN:EOC-Compute` as a prerequisite, so an admin-only member following it is told to request a group that this proTES access row says they do not need.

Clarify that `ECP_CLN:ADMIN` is an alternative for proTES access, or scope the compute-group prerequisite to services that require it.
</issue_to_address>

### Comment 4
<location path="docs/operators/services/protes.md" line_range="50" />
<code_context>
-services that it uses. The rest of its configuration, such as its plugins
-and how it authenticates at its TES services, is tracked in
-[generic-issues#31][gi-31].
+services that it uses.

-[gi-31]: <https://github.com/elixir-cloud-aai/generic-issues/issues/31>
</code_context>
<issue_to_address>
**Operators follow stale configuration link**

When a node operator follows the onboarding tutorial to find proTES configuration, the onboarding tutorial still directs readers to generic-issues#31 even though this page now records the configuration and the PR closes that issue, so operators land on a stale source instead of the maintained operator page.

Update the tutorial's proTES configuration pointer to this operator page and remove the outdated claim that the configuration is tracked in generic-issues#31.

Also at `docs/operators/services/protes.md:52`.
</issue_to_address>

Sourcery assessment

Approval pending. 4 findings to address first.

Blocking findings: docs/operators/services/protes.md:69, docs/operators/services/protes.md:80, docs/operators/services/protes.md:40, docs/operators/services/protes.md:50


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/operators/services/protes.md Resolved
Comment thread docs/operators/services/protes.md Resolved
Comment thread docs/operators/services/protes.md Resolved
Comment thread docs/operators/services/protes.md Resolved

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New gaps against the linked issues

Comment thread docs/operators/services/protes.md Resolved
The group mapping matches the EOC-Compute and ADMIN subgroup values,
not the parent ECP_CLN value, which LS Login releases only if the
parent group is assigned to the client's facility (generic-issues#46).

Addresses a Sourcery review thread.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New gaps against the linked issues

Comment thread docs/operators/services/protes.md Resolved
Comment thread docs/operators/services/protes.md Resolved
@uniqueg
uniqueg merged commit aaa6c2c into main Nov 18, 2026
17 checks passed
@uniqueg
uniqueg deleted the docs/gi31-protes-config branch November 18, 2026 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: configure proTES for ELIXIR On-Cloud

1 participant